<!DOCTYPE HTML><html><head><title>SLL Service Catalogue Offers Service API documentation</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="generator" content="https://github.com/kevinrenskers/raml2html 1.6.0"><link rel="stylesheet" href="http://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css"><link rel="stylesheet" href="http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/styles/default.min.css"><script type="text/javascript" src="http://code.jquery.com/jquery-1.11.0.min.js"></script><script type="text/javascript" src="http://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script><script type="text/javascript" src="http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/highlight.min.js"></script><script type="text/javascript">
        $(document).ready(function() {
            $('.page-header pre code, .top-resource-description pre code').each(function(i, block) {
                hljs.highlightBlock(block);
            });

            $('[data-toggle]').click(function() {
                var selector = $(this).data('target') + ' pre code';
                $(selector).each(function(i, block) {
                    hljs.highlightBlock(block);
                });
            });
            
            
            // open modal on hashes like #_action_get
            $(window).bind('hashchange', function(e) {
                var anchor_id = document.location.hash.substr(1); //strip #
                var element = $('#' + anchor_id);

                // do we have such element + is it a modal?  --> show it
                if (element.length && element.hasClass('modal')) {
                    element.modal('show');
                }
            });

            // execute hashchange on first page load
            $(window).trigger('hashchange');
            
            // remove url fragment on modal hide
            $('.modal').on('hidden.bs.modal', function() {
                if(history && history.replaceState) { 
                    history.replaceState({}, '', '#');
                }
            });
        });
    </script><style>
        .hljs {
            background: transparent;
        }
        .parent {
            color: #999;
        }
        .list-group-item > .badge {
            float: none;
            margin-right: 6px;
        }
        .panel-title > .methods {
            float: right;
        }
        .badge {
            border-radius: 0;
            text-transform: uppercase;
            width: 70px;
            font-weight: normal;
            color: #f3f3f6;
            line-height: normal;
        }
        .badge_get {
            background-color: #63a8e2;
        }
        .badge_post {
            background-color: #6cbd7d;
        }
        .badge_put {
            background-color: #22bac4;
        }
        .badge_delete {
            background-color: #d26460;
        }
        .badge_patch {
            background-color: #ccc444;
        }
        .list-group, .panel-group {
            margin-bottom: 0;
        }
        .panel-group .panel+.panel-white {
            margin-top: 0;
        }
        .panel-group .panel-white {
            border-bottom: 1px solid #F5F5F5;
            border-radius: 0;
        }
        .panel-white:last-child {
            border-bottom-color: white;
            -webkit-box-shadow: none;
            box-shadow: none;
        }
        .panel-white .panel-heading {
            background: white;
        }
        .tab-pane ul {
            padding-left: 2em;
        }
        .tab-pane h2 {
            font-size: 1.2em;
            padding-bottom: 4px;
            border-bottom: 1px solid #ddd;
        }
        .tab-pane h3 {
            font-size: 1.1em;
        }
        .tab-content {
            border-left: 1px solid #ddd;
            border-right: 1px solid #ddd;
            border-bottom: 1px solid #ddd;
            padding: 10px;
        }
        #sidebar {
            margin-top: 30px;
            padding-right: 5px;
            overflow: auto;
            height: 90%;
        }
        .top-resource-description {
            border-bottom: 1px solid #ddd;
            background: #fcfcfc;
            padding: 15px 15px 0 15px;
            margin: -15px -15px 10px -15px;
        }
        .resource-description {
            border-bottom: 1px solid #fcfcfc;
            background: #fcfcfc;
            padding: 15px 15px 0 15px;
            margin: -15px -15px 10px -15px;
        }
        .resource-description p:last-child {
            margin: 0;
        }
        .list-group .badge {
            float: left;
        }
        .method_description {
            margin-left: 85px;
        }
        .method_description p:last-child {
            margin: 0;
        }
        .list-group-item {
            cursor: pointer;
        }
        .list-group-item:hover {
            background-color: #f5f5f5;
        }
    </style></head><body data-spy="scroll" data-target="#sidebar"><div class="container"><div class="row"><div class="col-md-9" role="main"><div class="page-header"><h1>SLL Service Catalogue Offers Service API documentation <small>version 1.0</small></h1><p>http://localhost:8080/offers/</p><h3 id="General-API-information"><a href="#General-API-information">General API information</a></h3><p>TODO! Description of the Offers Service Functions</p></div><div class="panel panel-default"><div class="panel-heading"><h3 id="_units" class="panel-title">OffersService</h3></div><div class="panel-body"><div class="top-resource-description"><p>Service for managing Offers per Care Unit.</p></div><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__units"><span class="parent"></span>/units</a> <span class="methods"><a href="#_units_get"><span class="badge badge_get">get</span></a> <a href="#_units_post"><span class="badge badge_post">post</span></a> <a href="#_units_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel__units" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_units_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"></div><div class="clearfix"></div></div><div onclick="window.location.href = '#_units_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Create a new Offer for a specific care unit.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#_units_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Update an Offer</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_units_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/units</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#_units_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_units_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested offers was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "array",
    "description": "a collection of offer service units",
    "items": { "$ref": "offerUnit" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "creationTime": 1393305743000,
  "productReferences": [
    {
        "capacities": null,
        "comment": null,
        "contractedPrice": null,
        "contractedProduct": false,
        "product": {
            "codes": null,
            "creationTime": null,
            "description": null,
            "displayName": null,
            "name": "62",
            "status": null,
            "updateTime": null,
            "updatedByHsaid": null
        }
      },
      "regionalUnitId": "SE2321000016-116V",
      "relativeDistinguishedName": null,
      "unitId": "SE2321000016-116V",
      "updateTime": 1393305743000
    }
  ]
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="_units_post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent"></span>/units</h4></div><div class="modal-body"><div class="alert alert-info"><p>Create a new Offer for a specific care unit.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_units_post_request" data-toggle="tab">Request</a></li><li><a href="#_units_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_units_post_request"><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "description": "A model object for the creation of an Offer",
    "properties": {
        "hsaID": { "type": "string", "required": true },
        "regionalUnitId": { "type": "string", "required": true },
        "sourceSystemHsaId": { "type": "string", "required": false },
        "organisation": { "$ref": "organisation", "required": false },
        "properties": { "$ref": "cvTypeList", "required": false }
    }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "hsaID" : "SE2321000016-1HF3",
  "regionalUnitId" : "126t"
}
</code></pre></div><div class="tab-pane" id="_units_post_response"><h2>HTTP status code <a href="http://httpstatus.es/201" target="_blank">201</a></h2><p>The requested Offer was successfully created</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="_units_put"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent"></span>/units</h4></div><div class="modal-body"><div class="alert alert-info"><p>Update an Offer</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_units_put_request" data-toggle="tab">Request</a></li><li><a href="#_units_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_units_put_request"><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "description": "A model object for the creation of an Offer",
    "properties": {
        "hsaID": { "type": "string", "required": true },
        "regionalUnitId": { "type": "string", "required": true },
        "sourceSystemHsaId": { "type": "string", "required": false },
        "organisation": { "$ref": "organisation", "required": false },
        "properties": { "$ref": "cvTypeList", "required": false }
    }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "hsaID" : "SE2321000016-1HF3",
  "regionalUnitId" : "126t"
}
</code></pre></div><div class="tab-pane" id="_units_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Update successful.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "description": "A model object for the creation of an Offer",
    "properties": {
        "hsaID": { "type": "string", "required": true },
        "regionalUnitId": { "type": "string", "required": true },
        "sourceSystemHsaId": { "type": "string", "required": false },
        "organisation": { "$ref": "organisation", "required": false },
        "properties": { "$ref": "cvTypeList", "required": false }
    }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "hsaID" : "SE2321000016-1HF3",
  "regionalUnitId" : "126t"
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__units__hsaID_"><span class="parent">/units</span>/{hsaID}</a> <span class="methods"><a href="#_units__hsaID__get"><span class="badge badge_get">get</span></a> <a href="#_units__hsaID__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel__units__hsaID_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Service for reading the Offers for a specific care unit HSA-id. TODO! REmove one of this one or /byUnitId?</p></div><div class="list-group"><div onclick="window.location.href = '#_units__hsaID__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Reads all Offers belonging to a specific Care Unit</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#_units__hsaID__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Delete an offer</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_units__hsaID__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/units</span>/{hsaID}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Reads all Offers belonging to a specific Care Unit</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_units__hsaID__get_request" data-toggle="tab">Request</a></li><li><a href="#_units__hsaID__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_units__hsaID__get_request"><h3>URI Parameters</h3><ul><li><strong>The Hsa-id for the care unit to list offer information for</strong>: <em>required (string )</em></li></ul></div><div class="tab-pane" id="_units__hsaID__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested capacity information was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "array",
    "description": "a collection of offer service units",
    "items": { "$ref": "offerUnit" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "hsaID": "SE2321000016-3TNL",
  "product": [
      {
          "capacity": [
              {
                  "code": "2",
                  "codeSystem": "oid.sll.vantetider",
                  "createdByHsaID": "CREATED",
                  "creationTime": 1425410281000,
                  "product": null,
                  "sourceSystemHsaID": "SOURCE",
                  "validTo": 1427410800000,
                  "value": "4"
              },
              {
                  "code": "1",
                  "codeSystem": "oid.sll.vantetider",
                  "createdByHsaID": "CREATED",
                  "creationTime": 1425410242000,
                  "product": null,
                  "sourceSystemHsaID": "SOURCE",
                  "validTo": 1427410800000,
                  "value": "16"
              }
          ],
          "hsaID": "SE2321000016-1HF3",
          "name": "40"
      }
  ]
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="_units__hsaID__delete"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/units</span>/{hsaID}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete an offer</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_units__hsaID__delete_request" data-toggle="tab">Request</a></li><li><a href="#_units__hsaID__delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_units__hsaID__delete_request"><h3>URI Parameters</h3><ul><li><strong>The Hsa-id for the care unit to list offer information for</strong>: <em>required (string )</em></li></ul></div><div class="tab-pane" id="_units__hsaID__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/204" target="_blank">204</a></h2><p>Offer was deleted successfully (no content in response body)</p></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__units__hsaID__product_"><span class="parent">/units/{hsaID}</span>/product/</a> <span class="methods"><a href="#_units__hsaID__product__post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel__units__hsaID__product_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Add a Product to a specific care unit</p></div><div class="list-group"><div onclick="window.location.href = '#_units__hsaID__product__post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_units__hsaID__product__post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/units/{hsaID}</span>/product/</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#_units__hsaID__product__post_request" data-toggle="tab">Request</a></li><li><a href="#_units__hsaID__product__post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_units__hsaID__product__post_request"><h3>URI Parameters</h3><ul><li><strong>The Hsa-id for the care unit to list offer information for</strong>: <em>required (string )</em></li></ul><h3>Query Parameters</h3><ul><li><strong>product</strong>: <em>(string )</em><p>The Product name to add.</p></li></ul></div><div class="tab-pane" id="_units__hsaID__product__post_response"><h2>HTTP status code <a href="http://httpstatus.es/201" target="_blank">201</a></h2><p>The requested Offer was successfully created</p></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__units__hsaID__products_"><span class="parent">/units/{hsaID}</span>/products/</a> <span class="methods"><a href="#_units__hsaID__products__post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel__units__hsaID__products_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Set the entire product list for a specific care unit.</p></div><div class="list-group"><div onclick="window.location.href = '#_units__hsaID__products__post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_units__hsaID__products__post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/units/{hsaID}</span>/products/</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#_units__hsaID__products__post_request" data-toggle="tab">Request</a></li><li><a href="#_units__hsaID__products__post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_units__hsaID__products__post_request"><h3>URI Parameters</h3><ul><li><strong>The Hsa-id for the care unit to list offer information for</strong>: <em>required (string )</em></li></ul><h3>Query Parameters</h3><ul><li><strong>product</strong>: <em>(string )</em><p>A comma separated list of product names to set. (RAML doesn&#39;t seem to have a way to set this, so it&#39;s just a string for now)</p></li></ul></div><div class="tab-pane" id="_units__hsaID__products__post_response"><h2>HTTP status code <a href="http://httpstatus.es/201" target="_blank">201</a></h2><p>The requested Offer was successfully created</p></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__units__hsaID__contract_"><span class="parent">/units/{hsaID}</span>/contract/</a> <span class="methods"><a href="#_units__hsaID__contract__post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel__units__hsaID__contract_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Add a Contract to a specific offer</p></div><div class="list-group"><div onclick="window.location.href = '#_units__hsaID__contract__post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_units__hsaID__contract__post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/units/{hsaID}</span>/contract/</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#_units__hsaID__contract__post_request" data-toggle="tab">Request</a></li><li><a href="#_units__hsaID__contract__post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_units__hsaID__contract__post_request"><h3>URI Parameters</h3><ul><li><strong>The Hsa-id for the care unit to list offer information for</strong>: <em>required (string )</em></li></ul><h3>Query Parameters</h3><ul><li><strong>contract</strong>: <em>(string )</em><p>The Contract UUID to add to the Offer.</p></li></ul></div><div class="tab-pane" id="_units__hsaID__contract__post_response"><h2>HTTP status code <a href="http://httpstatus.es/201" target="_blank">201</a></h2><p>The requested Contract was successfully added to the Offer</p></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__units__hsaID__contracts_"><span class="parent">/units/{hsaID}</span>/contracts/</a> <span class="methods"><a href="#_units__hsaID__contracts__post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel__units__hsaID__contracts_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Set the entire contract list for a specific care unit.</p></div><div class="list-group"><div onclick="window.location.href = '#_units__hsaID__contracts__post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_units__hsaID__contracts__post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/units/{hsaID}</span>/contracts/</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#_units__hsaID__contracts__post_request" data-toggle="tab">Request</a></li><li><a href="#_units__hsaID__contracts__post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_units__hsaID__contracts__post_request"><h3>URI Parameters</h3><ul><li><strong>The Hsa-id for the care unit to list offer information for</strong>: <em>required (string )</em></li></ul><h3>Query Parameters</h3><ul><li><strong>contract</strong>: <em>(string )</em><p>A comma seperated list of contract UUID:s to set. (RAML doesn&#39;t seem to have a way to set this, so it&#39;s just a string for now)</p></li></ul></div><div class="tab-pane" id="_units__hsaID__contracts__post_response"><h2>HTTP status code <a href="http://httpstatus.es/201" target="_blank">201</a></h2><p>The requested Contracts were successfully added to the Offer</p></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__units_byunitids"><span class="parent">/units</span>/byunitids</a> <span class="methods"><a href="#_units_byunitids_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel__units_byunitids" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>List all Offers for an incoming list of Care Unit HSA-id:s</p></div><div class="list-group"><div onclick="window.location.href = '#_units_byunitids_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_units_byunitids_post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/units</span>/byunitids</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#_units_byunitids_post_request" data-toggle="tab">Request</a></li><li><a href="#_units_byunitids_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_units_byunitids_post_request"><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object",
  "description": "a collection of UnitIds",
  "properties": {
    "units": { 
      "type": "array",
      "items": { "$ref": "unit" }
    }
  }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
    "units": [
        {
            "unitId": "SE2321000016-14VK"
        },
        {
            "unitId": "SE2321000016-3M0N"
        }
    ]
}
</code></pre></div><div class="tab-pane" id="_units_byunitids_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested Offers information was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "array",
    "description": "a collection of offer service units",
    "items": { "$ref": "offerUnit" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  {
    "creationTime": 1393305728000,
    "productReferences": [
        {
            "capacities": null,
            "comment": null,
            "contractedPrice": null,
            "contractedProduct": false,
            "product": {
                "codes": null,
                "creationTime": null,
                "description": null,
                "displayName": null,
                "name": "116",
                "status": null,
                "updateTime": null,
                "updatedByHsaid": null
            }
        }
    ],
    "regionalUnitId": "SE2321000016-3M0N",
    "relativeDistinguishedName": null,
    "unitId": "SE2321000016-3M0N",
    "updateTime": 1393305728000
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__units_byunitid__unitId_"><span class="parent">/units</span>/byunitid/{unitId}</a> <span class="methods"><a href="#_units_byunitid__unitId__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel__units_byunitid__unitId_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Service for reading the Offers for a specific care unit HSA-id. TODO! REmove one of this one or the Root /{HsaId}?</p></div><div class="list-group"><div onclick="window.location.href = '#_units_byunitid__unitId__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Reads all Offers belonging to a specific Care Unit</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_units_byunitid__unitId__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/units</span>/byunitid/{unitId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Reads all Offers belonging to a specific Care Unit</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_units_byunitid__unitId__get_request" data-toggle="tab">Request</a></li><li><a href="#_units_byunitid__unitId__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_units_byunitid__unitId__get_request"><h3>URI Parameters</h3><ul><li><strong>The Hsa-id for the care unit to list offer information for</strong>: <em>required (string )</em></li></ul></div><div class="tab-pane" id="_units_byunitid__unitId__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested capacity information was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "array",
    "description": "a collection of offer service units",
    "items": { "$ref": "offerUnit" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "hsaID": "SE2321000016-3TNL",
  "product": [
      {
          "capacity": [
              {
                  "code": "2",
                  "codeSystem": "oid.sll.vantetider",
                  "createdByHsaID": "CREATED",
                  "creationTime": 1425410281000,
                  "product": null,
                  "sourceSystemHsaID": "SOURCE",
                  "validTo": 1427410800000,
                  "value": "4"
              },
              {
                  "code": "1",
                  "codeSystem": "oid.sll.vantetider",
                  "createdByHsaID": "CREATED",
                  "creationTime": 1425410242000,
                  "product": null,
                  "sourceSystemHsaID": "SOURCE",
                  "validTo": 1427410800000,
                  "value": "16"
              }
          ],
          "hsaID": "SE2321000016-1HF3",
          "name": "40"
      }
  ]
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__units_byproductname__productName_"><span class="parent">/units</span>/byproductname/{productName}</a> <span class="methods"><a href="#_units_byproductname__productName__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel__units_byproductname__productName_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Service for reading the Offers for a specific product name.</p></div><div class="list-group"><div onclick="window.location.href = '#_units_byproductname__productName__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Reads all Offers belonging to care units that have a specific product names ties to them.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_units_byproductname__productName__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/units</span>/byproductname/{productName}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Reads all Offers belonging to care units that have a specific product names ties to them.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_units_byproductname__productName__get_request" data-toggle="tab">Request</a></li><li><a href="#_units_byproductname__productName__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_units_byproductname__productName__get_request"><h3>URI Parameters</h3><ul><li><strong>The name of the product to list offer information for</strong>: <em>required (string )</em></li></ul></div><div class="tab-pane" id="_units_byproductname__productName__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested offer information was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "array",
    "description": "a collection of offer service units",
    "items": { "$ref": "offerUnit" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "hsaID": "SE2321000016-3TNL",
  "product": [
      {
          "capacity": [
              {
                  "code": "2",
                  "codeSystem": "oid.sll.vantetider",
                  "createdByHsaID": "CREATED",
                  "creationTime": 1425410281000,
                  "product": null,
                  "sourceSystemHsaID": "SOURCE",
                  "validTo": 1427410800000,
                  "value": "4"
              },
              {
                  "code": "1",
                  "codeSystem": "oid.sll.vantetider",
                  "createdByHsaID": "CREATED",
                  "creationTime": 1425410242000,
                  "product": null,
                  "sourceSystemHsaID": "SOURCE",
                  "validTo": 1427410800000,
                  "value": "16"
              }
          ],
          "hsaID": "SE2321000016-1HF3",
          "name": "40"
      }
  ]
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__units_byproductreferences_"><span class="parent">/units</span>/byproductreferences/</a> <span class="methods"><a href="#_units_byproductreferences__post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel__units_byproductreferences_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>List all Offers for an incoming list of Care Unit HSA-id:s</p></div><div class="list-group"><div onclick="window.location.href = '#_units_byproductreferences__post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_units_byproductreferences__post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/units</span>/byproductreferences/</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#_units_byproductreferences__post_request" data-toggle="tab">Request</a></li><li><a href="#_units_byproductreferences__post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_units_byproductreferences__post_request"><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object",
  "description": "a collection of Care Unit Reference Parameters",
  "properties": {
    "prList": { 
      "type": "array",
      "items": { "$ref": "productReferenceParam" }
    }
  }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
    "prList": [
        {
            "productReference": "5"
        },
        {
            "productReference": "6"
        }
    ]
}
</code></pre></div><div class="tab-pane" id="_units_byproductreferences__post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested Offers information was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "array",
    "description": "a collection of offer service units",
    "items": { "$ref": "offerUnit" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  {
    "creationTime": 1393305728000,
    "productReferences": [
        {
            "capacities": null,
            "comment": null,
            "contractedPrice": null,
            "contractedProduct": false,
            "product": {
                "codes": null,
                "creationTime": null,
                "description": null,
                "displayName": null,
                "name": "116",
                "status": null,
                "updateTime": null,
                "updatedByHsaid": null
            }
        }
    ],
    "regionalUnitId": "SE2321000016-3M0N",
    "relativeDistinguishedName": null,
    "unitId": "SE2321000016-3M0N",
    "updateTime": 1393305728000
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__units_updatedafter__timeStamp_"><span class="parent">/units</span>/updatedafter/{timeStamp}</a> <span class="methods"><a href="#_units_updatedafter__timeStamp__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel__units_updatedafter__timeStamp_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_units_updatedafter__timeStamp__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Returns unit id&#39;s for units where offer has been updated after the given timestamp.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_units_updatedafter__timeStamp__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/units</span>/updatedafter/{timeStamp}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Returns unit id&#39;s for units where offer has been updated after the given timestamp.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_units_updatedafter__timeStamp__get_request" data-toggle="tab">Request</a></li><li><a href="#_units_updatedafter__timeStamp__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_units_updatedafter__timeStamp__get_request"><h3>URI Parameters</h3><ul><li><strong>The timestamp offset formatted like &#x27;yyyyMMddHHmmss&#x27;.</strong>: <em>required (string )</em></li></ul></div><div class="tab-pane" id="_units_updatedafter__timeStamp__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested offer information was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object",
  "description": "a collection of UnitIds",
  "properties": {
    "units": { 
      "type": "array",
      "items": { "$ref": "unit" }
    }
  }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "units": [
    {
        "unitId": "SE2321000016-14VK"
    },
    {
        "unitId": "SE2321000016-3M0N"
    }
  ]
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="_contracts" class="panel-title">ContractsService</h3></div><div class="panel-body"><div class="top-resource-description"><p>Service for managing Contracts</p></div><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__contracts"><span class="parent"></span>/contracts</a> <span class="methods"><a href="#_contracts_get"><span class="badge badge_get">get</span></a> <a href="#_contracts_post"><span class="badge badge_post">post</span></a> <a href="#_contracts_put"><span class="badge badge_put">put</span></a></span></h4></div><div id="panel__contracts" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_contracts_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>List all contracts</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#_contracts_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Create a new Contract</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#_contracts_put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Update a Contract</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_contracts_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/contracts</h4></div><div class="modal-body"><div class="alert alert-info"><p>List all contracts</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_contracts_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_contracts_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>The requested contract information was found and is returned in the body.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "array",
  "description": "a collection of Contracts",
  "items": { "$ref": "contract" }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "contracts": [
    {
      "id":
      {
        "extension": "7f6c9cc1-7495-4b83-902b-f8e3220984ba",
        "root": "1.5.8.457.2.2"
      },
      "type":
      {
        "codeSystem": "1.2.758.9.21.3.1",
        "code": "45"
      },
      "datePeriod":
      {
        "start": "1427410800000",
        "end": "1448552000000"
      }
    }
  ]
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="_contracts_post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent"></span>/contracts</h4></div><div class="modal-body"><div class="alert alert-info"><p>Create a new Contract</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_contracts_post_request" data-toggle="tab">Request</a></li><li><a href="#_contracts_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_contracts_post_request"><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object",
  "description": "A single contract",
  "properties": {
    "id": { "$ref": "iiType", "required": true },
    "type": { "$ref": "cvType", "required": true },
    "datePeriod": { "$ref": "datePeriod", "required": true }
  }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "id":
  {
     "extension": "7f6c9cc1-7495-4b83-902b-f8e3220984ba",
     "root": "1.5.8.457.2.2"
  },
  "type":
  {
    "codeSystem": "1.2.758.9.21.3.1",
    "code": "45"
  },
  "datePeriod":
  {
    "start": "1427410800000",
    "end": "1448552000000"
  }
}
</code></pre></div><div class="tab-pane" id="_contracts_post_response"><h2>HTTP status code <a href="http://httpstatus.es/201" target="_blank">201</a></h2><p>The requested Contract was successfully created</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="_contracts_put"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent"></span>/contracts</h4></div><div class="modal-body"><div class="alert alert-info"><p>Update a Contract</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_contracts_put_request" data-toggle="tab">Request</a></li><li><a href="#_contracts_put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_contracts_put_request"><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object",
  "description": "A single contract",
  "properties": {
    "id": { "$ref": "iiType", "required": true },
    "type": { "$ref": "cvType", "required": true },
    "datePeriod": { "$ref": "datePeriod", "required": true }
  }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "id":
  {
     "extension": "7f6c9cc1-7495-4b83-902b-f8e3220984ba",
     "root": "1.5.8.457.2.2"
  },
  "type":
  {
    "codeSystem": "1.2.758.9.21.3.1",
    "code": "45"
  },
  "datePeriod":
  {
    "start": "1427410800000",
    "end": "1448552000000"
  }
}
</code></pre></div><div class="tab-pane" id="_contracts_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Update successful.</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object",
  "description": "A single contract",
  "properties": {
    "id": { "$ref": "iiType", "required": true },
    "type": { "$ref": "cvType", "required": true },
    "datePeriod": { "$ref": "datePeriod", "required": true }
  }
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
  "id":
  {
     "extension": "7f6c9cc1-7495-4b83-902b-f8e3220984ba",
     "root": "1.5.8.457.2.2"
  },
  "type":
  {
    "codeSystem": "1.2.758.9.21.3.1",
    "code": "45"
  },
  "datePeriod":
  {
    "start": "1427410800000",
    "end": "1448552000000"
  }
}
</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel__contracts__contractId__"><span class="parent">/contracts</span>/{contractId}/</a> <span class="methods"><a href="#_contracts__contractId___delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel__contracts__contractId__" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_contracts__contractId___delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>Delete a contract</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_contracts__contractId___delete"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/contracts</span>/{contractId}/</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete a contract</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_contracts__contractId___delete_request" data-toggle="tab">Request</a></li><li><a href="#_contracts__contractId___delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_contracts__contractId___delete_request"><h3>URI Parameters</h3><ul><li><strong>The id of the contract to work with.</strong>: <em>required (string )</em></li></ul></div><div class="tab-pane" id="_contracts__contractId___delete_response"><h2>HTTP status code <a href="http://httpstatus.es/204" target="_blank">204</a></h2><p>The contract was deleted successfully (no content in response body)</p></div></div></div></div></div></div></div></div></div></div></div><div class="col-md-3"><div id="sidebar" class="hidden-print affix" role="complementary"><ul class="nav nav-pills nav-stacked"><li><a href="#_units">OffersService</a></li><li><a href="#_contracts">ContractsService</a></li></ul></div></div></div></div></body></html>